Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix ConfigurationManager when BaseDirectory starts with \\?" #58627

Merged
merged 1 commit into from
Sep 6, 2021
Merged

Fix ConfigurationManager when BaseDirectory starts with \\?" #58627

merged 1 commit into from
Sep 6, 2021

Conversation

krwq
Copy link
Member

@krwq krwq commented Sep 3, 2021 •
edited
Loading

Fixes: #56897

Currently WinForms designer launches the process such that it prepends \\?\ because temporary directory it uses might end up with long path issues. This fixes the issue.

I did not find any scenarios where using Uri would have any benefits and Path.Combine seem to be fine to use.

Tested by creating a sample app which starts itself and prepends \\?\ to its own path and then executing ConfigurationManager.AppSettings.Get("foo") - in the success path it should return null, currently it throws an exception (only when process is launched with \\?\ prepended). Additionally tested the same when added App.config file with foo setting and made sure it read the value correctly.

Also tested by checking if Path.Combine correctly works for various paths (UNC, regular file path, \\?\ prepended path).

@krwq krwq requested review from jkotas and eerhardt September 3, 2021 13:08
@ghost
Copy link

ghost commented Sep 3, 2021

Tagging subscribers to this area: @safern
See info in area-owners.md if you want to be subscribed.

Issue Details

Fixes: #56897

Currently WinForms designed launches the process such that it prepends \\?\ because temporary directory it uses might end up with long path issues. This fixes the issue.

I did not find any scenarios where using Uri would have any benefits and Path.Combine seem to be fine to use.

Tested by creating a sample app which starts itself and prepends \\?\ to its own path and then executing ConfigurationManager.AppSettings.Get("foo") - in the success path it should return null, currently it throws an exception (only when process is launched with \\?\ prepended.

Also tested by checking if Path.Combine correctly works for various paths (UNC, regular file path, \\?\ prepended path).

Author: krwq
Assignees: -
Labels:

area-System.Configuration
Milestone: -

@eerhardt
Copy link
Member

eerhardt commented Sep 3, 2021

Here's the original commit that added the call to new Uri: dotnet/corefx@3f0fff2. Originally (in .NET Framework) we were stripping the file:/// and file:// prefixes from the path. Do we still need to do that? I believe that's what the intention of the new Uri(...).LocalPath was doing. Or are we guaranteed that AppDomain.CurrentDomain.BaseDirectory will never have file:// prefixes?

Also, side question: is new Uri(...) supposed to be able to handle \\?? Would that be a "more complete" fix?

@jkotas
Copy link
Member

jkotas commented Sep 3, 2021

Originally (in .NET Framework) we were stripping the file:/// and file:// prefixes from the path. Do we still need to do that?

It was necessary in .NET Framework because the code started with Assembly.CodeBase. Assembly.CodeBase is url (it can even be http://... in .NET Framework).

Or are we guaranteed that AppDomain.CurrentDomain.BaseDirectory will never have file:// prefixes?

Yes. BaseDirectory is always file path, no file:// prefix.

Also, side question: is new Uri(...) supposed to be able to handle \?? Would that be a "more complete" fix?

Maybe. Uri parsing is very complex with many legacy quirks and any fixes in it are risky and involved. Not a good candidate for .NET 6 fix.

Also, we may want to strip \\? from the BaseDirectory. I believe that our general approach is to avoid leaking \\? to user code where possible.

It may be a good idea to create a follow up issues for both of these.

eerhardt
eerhardt approved these changes Sep 3, 2021
View reviewed changes
Copy link
Member

@eerhardt eerhardt left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Given @jkotas's answers above, this LGTM.

It may be a good idea to create a follow up issues for both of these.

+1

This was referenced Sep 6, 2021
Closed
Open
@krwq krwq merged commit b7e1037 into dotnet:main Sep 6, 2021
@krwq
Copy link
Member Author

krwq commented Sep 6, 2021

Thanks @jkotas and @eerhardt!

@ghost ghost locked as resolved and limited conversation to collaborators Oct 6, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@eerhardt eerhardt eerhardt approved these changes

@jkotas jkotas jkotas approved these changes

Assignees
No one assigned
Labels
area-System.Configuration
Projects
No open projects
Triage POD for Reflection, META, etc.
Status: Done
Milestone
No milestone
3 participants
@krwq @eerhardt @jkotas